Skip to content

docs: fix outdates docs + internal apis#1958

Merged
caio-pizzol merged 45 commits intomainfrom
caio/sd-1572-fix-outdated-docs-mark-internal-apis
Feb 6, 2026
Merged

docs: fix outdates docs + internal apis#1958
caio-pizzol merged 45 commits intomainfrom
caio/sd-1572-fix-outdated-docs-mark-internal-apis

Conversation

@caio-pizzol
Copy link
Contributor

No description provided.

@linear
Copy link

linear bot commented Feb 5, 2026

Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 24ee45489f

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

- Remove togglePagination (not implemented)
- Remove pagination config (not in defaults)
- Remove telemetry config (not in code)
- Remove deprecated layoutMode/layoutMargins
- Remove creating-extensions link (page removed from nav)
- Remove internal properties (stores, Vue app, Pinia, ydoc, socket)
- Clean up events page (remove verbose patterns)
- Fix formatting issues in configuration
- Fix stray backtick in overview
Both now follow: Overview → Configuration → Methods → Events

- Merge Properties + Types into SuperDoc Methods page
- Rename SuperEditor Hooks → Events for consistency
- Remove properties and types from nav, add redirects
- Update cross-references (storage.mdx, overview pages)
Add undocumented methods (setActiveEditor, setDisableContextMenu,
setTrackedChangesPreferences), events (editorBeforeCreate, sidebar-toggle,
exception), properties (element, state), and config options (jsonOverride,
uiDisplayFallbackFont, onEditorBeforeCreate, onSidebarToggle, onException).
Apply consistent structure across all module pages:
Quick Start → Configuration → Features → API → Events → Types.

- Overview: trim to concise SuperDoc connection
- Comments: remove verbose patterns, reorder sections
- Toolbar: remove patterns/troubleshooting/ToolbarItem internals, fix MDX
- Collaboration overview: remove marketing cards and duplicated content
- Collaboration config: remove general SuperDoc events, keep collab-specific
…ze sections

- Move collaboration provider guides from Modules to new Guides section
- Merge standalone Guides tab content into Editor tab
- Move Accessibility and Security under Resources
- Simplify Modules/Collaboration to overview, quickstart, config only
- Update redirect for modules/collaboration/backend
- Replace insertComment (private) with addComment (public API)
- Add addCommentReply, setCommentInternal, setCursorById methods
- Add highlight/theming config (highlightColors, highlightOpacity, etc.)
- Add showResolved, trackChangeHighlightColors config options
- Add change-accepted/change-rejected event types
- Add missing Comment fields (fileType, trackedChangeText, deletedText)
- Fix suppressInternalExternalComments → suppressInternalExternal
- Fix trackedChangeType to include 'both' value
- Fix button names to match codebase (strike not strikethrough, textAlign not individual align buttons)
- Remove non-existent buttons (addComment, acceptChange, rejectChange)
- Add missing buttons: link, image, table, tableActions, lineHeight, linkedStyles,
  ruler, copyFormat, clearFormatting, zoom, undo, redo, search
- Add correct track change button names (acceptTrackedChangeBySelection, rejectTrackedChangeOnSelection)
- Add missing API methods: getToolbarItemByGroup, setZoom, destroy
- Remove non-existent state-update event, add exception event
- Reorganize button list into clearer categories
- Fix awareness state properties (remove cursor/selection, not in normalized payload)
- Add onLocked event (fires on document lock/unlock)
- Fix quickstart dead link to self-hosted/overview
Fix wrong API names (editor.exportDocx → superdoc.export), add missing
export params, document getMarkdown, fix typos, and match reference style.
Replace abstract examples with real OpenAI workflow, fix wrong API names,
trim to high-level overview and link to detailed pages.
Remove we/our framing, enterprise-grade buzzword, and long
run-on sentences. Use you/your framing and short scannable prose.
Replace we/our with you/your or neutral phrasing across 9 files.
Remove buzzwords (comprehensive, seamless). Fix missed Title Case
headings and rename "What it is" to "What it does".
Fix Source Code, Keyboard Shortcuts, Use Case, and other
Title Case headings across 92 extension and snippet files.
Also fix remaining we-framing in field-annotation and
typescript-migration.
Replace our → the, remove we recommend patterns.
Zero instances of we/our remain in any doc page.
- strike: fix keyboard shortcut from Mod-Shift-s to Mod-Shift-x
- text-align: remove phantom options (types, defaultAlignment) and attribute (textAlign)
- field-annotation: fix annotationClass default, rename defaultColor to borderColor, remove ghost maxAnnotations
- run-item: fix source code link to run/run.js
- text-indent: fix command names (setTextIndentation), param type (number in points), remove phantom options
- line-height: fix param type (number multiplier), remove phantom options/attributes, fix source link
…t-item)

These pages documented extensions that don't exist as separate source files.
List functionality lives in the Paragraph extension.

- bullet-list: remove phantom options/attributes, point to paragraph.js
- ordered-list: remove ghost commands (restartListNodes, updateOrderedListStyleType),
  add real restartNumbering command
- list-item: remove misattributed commands from linked-styles/custom-selection,
  keep keyboard shortcuts and numbering formats
- comments: replace 4 ghost commands with 7 real ones (addComment, addCommentReply,
  removeComment, resolveComment, setActiveComment, setCommentInternal, setCursorById)
- track-changes: replace 4 ghost commands with all 21 real commands, fix helper names
- linked-styles: fix title from "CustomSelection" to "Linked Styles", remove mixed
  content, correct source link
- document-section: remove 3 ghost config options, 4 ghost events, ghost limitations
…12 extension pages

SD-1572: Added missing API surface that existed in code but was
undocumented. Also removed phantom options, attributes, and types
that don't exist in the actual extensions.
…dex, permission-ranges

SD-1572: Created extension pages for 5 previously undocumented
extensions and added them to the docs navigation. Bookmarks has
full command documentation; the others document Word compatibility
behavior.
Replace Harbour-Enterprises/SuperDoc with superdoc-dev/superdoc
across all 17 documentation files.
@caio-pizzol caio-pizzol merged commit 61fd682 into main Feb 6, 2026
7 checks passed
@caio-pizzol caio-pizzol deleted the caio/sd-1572-fix-outdated-docs-mark-internal-apis branch February 6, 2026 16:16
@superdoc-bot
Copy link

superdoc-bot bot commented Feb 6, 2026

🎉 This PR is included in superdoc v1.11.0-next.21

The release is available on GitHub release

@superdoc-bot
Copy link

superdoc-bot bot commented Feb 6, 2026

🎉 This PR is included in superdoc v1.12.0-next.1

The release is available on GitHub release

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant